Update the README and contribution guidelines to reflect the new development workflow#89
Conversation
ghost
left a comment
There was a problem hiding this comment.
I only looked over the blackbox section, but LGTM!
nhlien93
left a comment
There was a problem hiding this comment.
looks good, just a couple comments.
also just making sure, the last parts of the README-dev.md was just adding newlines right? I didn't see any world differences.
11a6ef7
| #### Blackbox tests targeting wrappers (mostly Delphix Engine workflows) | ||
| * appdata_python_samples (sample plugins from the app-gate): | ||
| `git blackbox -s appdata_python_samples --extra-params="-p virt-sdk-repo=https://github.com/<username>/virtualization-sdk.git -p virt-sdk-branch=my-feature"`, | ||
| * appdata_sanity with a direct Python plugin on CentOS 7.3: `git blackbox -s appdata_sanity -c APPDATA_PYTHON_DIRECT_CENTOS73 -a --extra-params="-p virt-sdk-repo=https://github.com/<username>/virtualization-sdk.git -p virt-sdk-branch=my-feature"`, | ||
| * appdata_sanity with a staged Python plugin on CentOS 7.3: `git blackbox -s appdata_sanity -c APPDATA_PYTHON_STAGED_CENTOS73 -a --extra-params="-p virt-sdk-repo=https://github.com/<username>/virtualization-sdk.git -p virt-sdk-branch=my-feature"`. | ||
|
|
||
| #### Blackbox tests targeting the CLI (~80% CLI tests) | ||
| * virtualization_sdk (installs and tests a direct Python plugin on Ubuntu 18): | ||
| `git blackbox -s virtualization_sdk -c APPDATA_SDK_UBUNTU18_DIRECT_CENTOS73 --extra-params="-p virt-sdk-repo=https://github.com/<username>/virtualization-sdk.git -p virt-sdk-branch=my-feature"`, | ||
| * virtualization_sdk (installs and tests a staged Python plugin on Ubuntu 18): | ||
| `git blackbox -s virtualization_sdk -c APPDATA_SDK_UBUNTU18_STAGED_CENTOS73 --extra-params="-p virt-sdk-repo=https://github.com/<username>/virtualization-sdk.git -p virt-sdk-branch=my-feature"`. No newline at end of file |
There was a problem hiding this comment.
can we clarify what is the minimal set or "sanity" set that needs to be run as part of a PR, like have appdata_sanity as a single suite to run.
There was a problem hiding this comment.
I added the following to the Functional (blackbox) testing section:
"At minimum, each pull request should pass appdata_python_samples and appdata_sanity tests with a direct or staged plugin. See the section below for the description of each test suite."
Pull request checklist
Please check if your PR fulfills the following requirements:
Pull request type
Please check the type of change your PR introduces:
What is the current behavior?
The README was a little outdated, had mentions of the old Gradle build, and few errors.
What is the new behavior?
README-dev.md describes the new development workflow.
Does this introduce a breaking change?
Other information